Notify

function

Notify()

Option name	Type	Description
flowviz	FlowViz	A reference to the current instance of the FlowViz library

The Notify module manages displaying messages from the FlowViz library to the end user. This can include standard
status messages, warning messages, or error messages

function Notify(flowviz) {
    fv = flowviz;

    if(fv.Config.ShowDefaultMsgs) {
        var div = $('<div id="notify-message" class="notify-hide"><span /></div>');
        $('body').append(div);

        fv.on('notify-std', stdMsg);
        fv.on('notify-warn', warnMsg);
        fv.on('notify-error', errorMsg);

        fv.on('notify-clear', clearMsg);
    }
}

stdMsg

function

stdMsg()

Option name	Type	Description
msg	string	The message to display
duration	number	The time (ms) to display the message

Shows a standard status message in the corner of the interface.

function stdMsg(msg, duration) {
    if(duration === undefined) {
        duration = module.exports.NORMAL;
    }

    $('#notify-message').text(msg);
    $('#notify-message').removeClass('notify-hide');

    setTimeout(function() {
        $('#notify-message').addClass('load');

        if(duration >= 0) {
            setTimeout(function () {
                $('#notify-message').removeClass('load');
                setTimeout(function () {
                    $('#notify-message').addClass('notify-hide');
                }, 500);
            }, duration);
        }
    }, 100);
}

warnMsg

function

warnMsg()

Option name	Type	Description
msg	string	The message to display
duration	number	The time (ms) to display the message

Shows a warning message in the corner of the interface.

function warnMsg(msg, duration) {
    if(duration === undefined) {
        duration = module.exports.NORMAL;
    }

    $('#notify-message').text(msg);
    $('#notify-message').removeClass('notify-hide');

    setTimeout(function() {
        $('#notify-message').addClass('warn');
        $('#notify-message').addClass('load');

        if(duration >= 0) {
            setTimeout(function () {
                $('#notify-message').removeClass('load');
                setTimeout(function () {
                    $('#notify-message').addClass('notify-hide');
                    $('#notify-message').removeClass('warn');
                }, 500);
            }, duration);
        }
    }, 100);
}

errorMsg

function

errorMsg()

Option name	Type	Description
msg	string	The message to display
duration	number	The time (ms) to display the message

Shows an error message in the corner of the interface.

function errorMsg(msg, duration) {
    if(duration === undefined) {
        duration = module.exports.NORMAL;
    }

    $('#notify-message').text(msg);
    $('#notify-message').removeClass('notify-hide');

    setTimeout(function() {
        $('#notify-message').addClass('error');
        $('#notify-message').addClass('load');

        if(duration >= 0) {
            setTimeout(function () {
                $('#notify-message').removeClass('load');
                setTimeout(function () {
                    $('#notify-message').addClass('notify-hide');
                    $('#notify-message').removeClass('error');
            }, 500);
            }, duration);
        }
    }, 100);
}

clearMsg

function

clearMsg()

Clears any messages from the interface.

function clearMsg() {
    $('#notify-message').removeClass('load');

    setTimeout(function () {
        $('#notify-message').addClass('notify-hide');
        $('#notify-message').removeClass('error');
        $('#notify-message').removeClass('warn');
    }, 500);
}